home *** CD-ROM | disk | FTP | other *** search
- I N S T A L L 3 . 3 7
-
- September 6, 1991
- Mark Wilden
-
-
-
- This manual describes Install, a program that installs a program on a
- user's hard or floppy disk. Install shows the user the hardware and
- software options it thinks are most suitable, asks for his
- confirmation of these choices, then runs a script which typically
- creates a subdirectory for the game on the user's hard disk and copies
- the necessary files to it.
-
- This manual is updated regularly and is stored in ASCII format with
- the rest of Install, in the S:INSTALL directory
- (APPS/VOL1:/GAMES/SCI/SYSTEM/INSTALL). See the last section "Changes"
- for a revision history.
-
-
- Starting Install
-
- The user starts the Install program by logging onto the disk drive
- that contains the Install program and typing INSTALL. After a pause
- to read files from the installation disk, an introductory screen is
- displayed. The user can press ENTER at this screen to continue or ESC
- to cancel installation.
-
-
- Choosing a Destination Drive
-
- The next screen asks the user to select which hard disk to install the
- game to. Only drives C: and above are allowed (unless the FLOPPY=YES
- option is present--see below). The user can press ESC to cancel
- installation at this point, or type a valid drive letter to continue.
-
- The Install program will look on the hard disk specified to see if the
- game was previously installed, in which case the user's old choices
- will be used on the next screen.
-
-
- Confirming Installation Choices
-
- The Installation Choices screen shows the user what hardware and
- software options it thinks are most suitable for running the game. At
- this point the user can:
-
- Choose "View documention update in README file" (if there is a
- file called README or READ.ME on the installation disk).
- Choose "Accept these choices" to continue the installation,
- Choose "Cancel installation" to return to DOS,
- Install 3.37 September 6, 1991
-
-
- Press ESC to return to the previous screen (the destination drive
- choice), or
- Move the highlight to a choice and press ENTER to change it.
-
- Changing an Installation Choice
-
- If the user wants to change an installation choice, a menu is shown
- with the possible choices for that item on it. In general, the
- choices will be listed in decreasing order of desirability. A check
- mark is displayed beside each choice that the Install program has
- detected the user's machine can support.
-
- The user can put the highlight on a given choice and press F1 to get
- help for that choice, if available. In addition, some choices will
- bring up an additional screen of information if the user chooses it.
- If the user selects a choice that the program feels is not supported
- by his hardware, a warning message is displayed and the user is asked
- to confirm his choice.
-
-
- Installation Menus
-
- Here are the specific installation choice menus for SCI games (TSN and
- CD games may have different screens). If there is only one choice
- possible for a given type of option, the choice won't be displayed on
- the Installation Choices screen (such as the Video choice for a VGA-
- only game).
-
- Video This menu shows the video card and monitor choices. The
- Install program can detect what video card the user has, so
- he should rarely have to use this menu to change the default
- video choice.
-
- Sound Here is where the user selects what sound card to use.
- Again, we can usually detect this, with the exception of the
- Game Blaster card. Also, we consider that the user has a
- Roland card if he has any MIDI device attached.
-
- Speech This menu allows users of CD games to specify the driver to
- use for speech and other CD audio.
-
- Joystick This menu allows the user to specify whether to use his
- joystick or not. We detect the presence of a joystick.
-
- Mouse We detect whether the user has a mouse, but this menu allows
- him to choose not to have the game use it.
-
- Memory This menu lets the user turn off our use of his extra memory
- (expanded, extended, XMS and/or extra video memory) if he
- has any. Pressing F1 at this menu shows the user which of
- these types of extra memory he has, and how much of each is
- available.
-
-
- Page 2
-
- Install 3.37 September 6, 1991
-
-
- Returning to Default Choices
-
- If the user changes any of the choices Install suggested for him when
- the game was first installed, an additional choice will be available:
- "Return to Sierra defaults." This lets him start over with a clean
- slate.
-
-
- Accepting Installation Choices
-
- After the user chooses "Accept these choices" from the Installation
- Choices screen, he may be shown various information screens, such as a
- warning to turn off NUMLOCK before playing the game. He can either
- press ENTER at these screens or ESC to go back and change the
- selection.
-
-
- Installing the Game
-
- At this point, the game is actually installed on the user's hard disk
- by executing the installation script in INSTALL.SCR. This script
- usually asks additional questions of the user depending on the
- individual game, checks the user's disk for sufficient free space,
- creates a subdirectory and copies the game files. The installation
- floppy disk is not modified. After the script has completed, the user
- presses a key to exit Install and proceeds to have fun.
-
-
- Installing Without Hardware Autodetection
-
- When the Install program starts, it performs various tests to
- determine the user's hardware configuration. It is conceivable that
- these tests could hang the user's machine. In this event, the Install
- program can be started with the -m command line flag by typing
- INSTALL -m at the DOS prompt. This flag disables autodetection. The
- user will be presented with a sequence of menus from which to select
- his hardware configuration.
-
- To enable autodetection selectively, follow the -m flag with a number
- specifying the autodetection desired:
-
- VIDEO 1
- MUSIC 2
- VOICE 4
- JOYSTICK 8
- KEYBOARD 16
- COMM 32
- MOUSE 64
- MEMORY 128
-
-
-
-
-
- Page 3
-
- Install 3.37 September 6, 1991
-
-
- For example, to enable music autodetection only, use INSTALL -m2. Add
- numbers together to enable more than one autodetection. For example,
- to enable memory and video autodetection (128 + 1 = 129) use
- INSTALL -m129. This option is available primarily for debugging
- purposes.
-
-
- Changing Configuration and Updating a Game
-
- If the user needs to change his configuration after installing the
- game, he can run the Install program again from his hard drive. He
- will not be asked which drive to install to, and his previous choices
- will be displayed for him to change.
-
- In the case of updating a game from floppy, after selecting the drive
- to install to the old configuration will be presented for the user to
- change if necessary.
-
-
- Required Files
-
- A typical game will require many different files, which are used
- during the installation process by INSTALL.SCR. These will be
- resources, patches, batch files, etc.
-
- The files required by the Install program itself are:
-
- INSTALL.EXE The program.
-
- INSTALL.HLP Besides help and information messages, this file also
- contains the names of the driver files that are
- displayed as menu choices. The order of these entries
- in the file determines the order of the menu choices.
-
- INSTALL.TXT This file contains the rest of the text displayed by
- the program. If either this file or INSTALL.HLP is not
- found on the current drive, the Install program won't
- be able to locate its text, and an error message will
- be displayed.
-
- INSTALL.SCR This file contains the commands to actually copy a game
- to a user's disk. The Install program will run without
- this file, but there wouldn't be much point.
-
-
-
-
-
-
-
-
-
-
-
- Page 4
-
- Install 3.37 September 6, 1991
-
-
- The following is information of interest mainly to programmers.
-
-
- Menu Choices
-
- Menus in general are created from the driver files found on the
- installation disk. If there are no driver files of a given menu's
- type on disk (like CD speech, for example), no menu will be displayed
- and no choice will be recorded in RESOURCE.CFG. If there is only one
- driver file (e.g. VGA320.DRV for a VGA-only game), the menu won't be
- displayed and that driver will be recorded in RESOURCE.CFG
- automatically.
-
- The order of driver menu choices is determined by the order of the
- corresponding text entries in INSTALL.HLP.
-
-
- Help, Information and Warnings
-
- There can be help and/or information for each menu choice. A help
- entry is displayed when the user highlights the choice and presses F1.
-
- An information entry is displayed when the user selects a choice by
- pressing ENTER on it. In general, an information item is provided to
- warn the user of some condition (e.g. to turn off NUMLOCK in order to
- control Ego with the keypad cursor keys). When the information is
- displayed, the user has the option of pressing ENTER to continue, or
- ESC to go back and change his choice.
-
- If the user doesn't go to any of the individual menus to change the
- default choices, all appropriate information screens will be shown
- when he accepts the choices shown on the Installation Choices menu.
- This makes sure he sees all warnings.
-
- There doesn't have to be help or information entries for all menu
- choices, though naturally help entries are desirable.
-
-
- Input Fields
-
- TSN Install contains some screens that are input fields instead of
- menus. Install will record the contents of these fields in the
- configuration file entry, rather than the name of a driver file.
-
-
- Viewing README
-
- If a file by the name README or READ.ME is present, the user can view
- it from within the Install program. The file should be formatted so
- that no lines are longer than 74 characters. Tabs are not expanded.
-
-
-
-
- Page 5
-
- Install 3.37 September 6, 1991
-
-
- Text Files
-
- Install stores all of the text it displays in the text files
- INSTALL.HLP and INSTALL.TXT, which must be included on the
- installation disk. INSTALL.HLP contains help and information;
- INSTALL.TXT contains all the rest of the text displayed by the
- program. These files have the format
-
- \\label
- text
- \\label
- text
- [etc...]
-
- where label is an identifying string, and text is the actual
- information. Case is not significant in label. Whitespace after the
- backslashes and after the label is stripped, but whitespace within the
- label is significant. Text can be as many lines as necessary. Each
- line can be up to 2000 characters long and will normally be
- wordwrapped if necessary when displayed by the program. A single line
- can be broken into separate lines if each line ends in a backslash.
- The backslash and newline will be deleted when read.
-
- At startup, Install scans the installation disk for INSTALL.TXT and
- INSTALL.HLP, then for any other .TXT and .HLP files and adds their
- contents to its dictionary of text entries. An entry for a given
- label overrides a previously defined entry. Therefore, if you want to
- override an entry without changing the default files, simply include
- another .TXT or .HLP file with the new entries.
-
- The labels for help, information and driver descriptions are of the
- form driver.hlp, driver.inf and driver.drv respectively, where driver
- represents the base name of the associated driver file or choice. The
- description of the driver used as the text for a menu choice is no
- longer taken from the driver file itself but comes from the text file
- INSTALL.HLP.
-
-
- Configuration File
-
- When the user chooses to accept the configuration on the Installation
- Choices menu, the choices are recorded in the RESOURCE.CFG file. For
- each item, a line is recorded in this file showing the driver chosen.
- For example, the Video menu will create a line like
- videoDrv = VGA320.DRV.
-
- Three menus act a little differently: The Joystick menu will record
- either joyDrv = JOYSTICK.DRV or joyDrv = NO. The Mouse menu will
- record either mouseDrv = STDMOUSE.DRV or mouseDrv = NO. The Memory
- menu will record either memoryDrv = ARM.DRV or memoryDrv = NO. Note
- that there are no driver files called STDMOUSE.DRV, ARM.DRV or NO.
-
-
-
- Page 6
-
- Install 3.37 September 6, 1991
-
-
- The Sound menu (and Speech menu, if present) has an additional
- capability: it can not only specify the sound driver, but can also
- specify the port number of the sound device, like soundDrv = MT32.DRV
- 34. This port number must be in hex and can be specified in the form
- 34, $34, 0x34, or 34h.
-
-
- Command Script Language
-
- If the user is running the Install program from a floppy drive (A: or
- B:) and the installation script file INSTALL.SCR is present, it will
- be executed. INSTALL.SCR uses a language very similar to MS-DOS
- Batch, but with enhancements. Typically, the installation script will
- display messages to the user, get input from him, check for sufficient
- disk space, create a subdirectory and copy files.
-
- Three variables are passed to the script by the Install program:
-
- %1, which is replaced by the destination drive
- %2, which is replaced by the installation source drive
- %3, which is replaced by the contents of RESOURCE.CFG.
-
- The trailing colon is not included in the drive parameters--you must
- supply it when you use the parameter in the script file.
-
- If the user is installing from floppy disk (as opposed to a reinstall
- from the hard disk in order to change options), it is the
- responsibility of the script file to create RESOURCE.CFG in the
- appropriate directory on the user's hard disk. It can't simply be
- copied from the floppy disk, since it isn't written there. The
- following command is necessary to create RESOURCE.CFG
-
- echo %3>resource.cfg
-
- and should be included in the section of the script file where other
- files are copied from the floppy disk to the user's hard disk. This
- approach eliminates writing to the floppy disk, which users object to,
- and also conforms to situations where the installation disk can't be
- written to, like CD-ROM products.
-
-
- Sample Installation Script
-
- Following is a sample INSTALL.SCR with annotations. It is intended
- for tutorial purposes only; the actual script will be dictated by your
- game's needs.
-
- echo You may Install one of two ways:
- echo
- Unlike DOS, an echo command with no parameters will output a
- blank line.
- echo SMALL install will only install the STARTUP DISK to your
-
-
- Page 7
-
- Install 3.37 September 6, 1991
-
-
- echo hard drive. You MUST play from floppies.
- echo Approximate hard drive space required: 1.2 Meg
- echo
- echo COMPLETE install will install all files to your hard drive.
- echo The entire game will be played from a hard drive.
- echo Approximate hard drive space required: 6.0 Meg
- echo
- echo Would you like to install (S)mall, (C)omplete or (E)xit?
- pick sce small large Exit
- This command allows the user to type s, c or e (upper or lower
- case), then branches to the first label (small) if the first key
- (s) was typed, the second label if the second key was typed, etc.
-
- :small
- cls
- space %1: 1200 NoSpace
- This command checks that the user has enough space on drive %1
- (the destination drive) for the game (in this case, 1200 K) and
- goes to the NoSpace label if he doesn't.
- godir %1:\sierra\sq4 CantCreate
- godir creates the directory specified and changes to it (going to
- the CantCreate label if the directory can't be created or changed
- to).
-
- This section will differ depending on the game, but note the
- creation of RESOURCE.CFG.
- echo Copying Startup Files ...
- copy %2:*.drv
- copy %2:*.hlp
- copy %2:*.txt
- Make sure you copy all the .TXT and .HLP files to the hard disk,
- or else the user won't be able to run the install program again
- from there.
- copy %2:version
- copy %2:scidhuv.exe
- copy %2:resource.000
- copy %2:resource.map
-
- echo %3 > resource.cfg
-
- copy %2:install.exe
- copy %2:sq4rs.bat %1:\sq4.bat
- copy %2:sq4rs.bat %1:\sierra\sq4.bat
- copy %2:sq4.bat
- copy %2:sierra.bat
- goto exit
-
- :large
- clear
- space %1: 6000 NoSpace
- godir %1:\sierra\sq4 CantCreate
- echo Copying Startup Files ...
-
-
- Page 8
-
- Install 3.37 September 6, 1991
-
-
- copy %2:*.drv
- copy %2:*.hlp
- copy %2:*.txt
- copy %2:version
- copy %2:scidhuv.exe
- copy %2:resource.000
- copy %2:resource.map
- echo %3 > resource.cfg
-
- copy %2:install.exe
- copy %2:sq4rs.bat %1:\sq4.bat
- copy %2:sq4rs.bat %1:\sierra\sq4.bat
- copy %2:sq4h.bat sq4.bat
- copy %2:sierrah.bat sierra.bat
-
- echo Copying Game files...
- These lines copy the resource files from each disk to the hard
- disk, checking to see if the file exists in the source floppy
- drive before prompting the user to insert it.
- exists %2:resource.001 Insert Disk 1 in drive %2:.
- copy %2:resource.001
- exists %2:resource.002 Insert Disk 2 in drive %2:.
- copy %2:resource.002
- exists %2:resource.003 Insert Disk 3 in drive %2:.
- copy %2:resource.003
- exists %2:resource.004 Insert Disk 4 in drive %2:.
- copy %2:resource.004
- exists %2:resource.005 Insert Disk 5 in drive %2:.
- copy %2:resource.005
-
- :exit
- clear
- echo
- echo To play NOW:
- echo Type SQ4 [ENTER].
- echo
- echo To play LATER:
- echo From the root directory of %1:,
- echo Type SQ4 and press [ENTER].
- echo
- pause
- end
-
- :NoSpace
- clear
- echo
- echo There is not enough space on %1: to install Space Quest IV!
- rem determine which message to bring up.
- space %1: 1200 NoSmall
- echo 6.0 megabytes of disk space are necessary.
- echo
- echo SMALL install will only install the STARTUP DISK
-
-
- Page 9
-
- Install 3.37 September 6, 1991
-
-
- echo to your hard drive. You MUST play from floppies.
- echo SMALL install is recommended, due to insufficient
- echo hard drive space.
- echo
- echo Would you like to install (S)mall or (E)xit?
- pick se small Exit
-
- :NoSmall
- alert 1.2 megabytes of disk space are necessary.
- end
-
- :Exit
- end
-
- :CantCreate
- alert Unable to create directory %1:\sierra\sq4
- end
-
-
-
- Script Command Reference
-
- The commands available in this language are:
-
-
- ALERT message
-
- Opens an alert window, displays message, and allows the user to
- press ENTER to continue, or ESC to exit Install.
-
-
- CLEAR
- CLS
-
- Clears the message window.
-
-
- COPY sourceSpec [destSpec]
-
- Copies a file or group of files. Wildcards are permitted. If no
- destSpec is supplied, copies to the current directory, which is
- usually the destination of the install, following a GODIR
- command.
-
-
- DEL fileSpec
-
- Deletes a file or group of files. Wildcards are permitted.
-
-
-
-
-
-
- Page 10
-
- Install 3.37 September 6, 1991
-
-
- ECHO text [> or >> file]
-
- With no redirection (> or >>) this command displays text to the
- user. The redirection symbols allow writing or appending text to
- a file. This is needed to create the batch file that runs the
- game, since this batch file should include a command to change to
- the correct drive.
-
-
- END
-
- Ends the script.
-
-
- EXISTS fileName alertMessage
-
- If filename doesn't exist, does an ALERT with alertMessage,
- allowing the user to either put in the correct disk or exit
- Install.
-
-
- GODIR path label
-
- Attempts to change directory to path, creating path if necessary.
- If unsuccessful, goes to label.
-
-
- GOTO label
-
- Considered harmful (just kidding).
-
-
- IF [NOT] ERRORLEVEL value command
-
- Compares the number value to the return value of the last program
- executed. If the return value was greater than or equal to
- value, command is executed. NOT reverses this logic. command
- can be any valid script command.
-
-
- PAUSE [message]
-
- If message is not specified, Press a key to continue... is
- displayed.
-
-
-
-
-
-
-
-
-
-
- Page 11
-
- Install 3.37 September 6, 1991
-
-
- PICK letters choice1 choice2 choice3 choice4
-
- Gets a keypress from the user, and branches to the appropriate
- choice. For example, if the command was
- PICK abcd aChoice bChoice cChoice dChoice
- and the user typed a C, the script would goto the label cChoice.
- Case is not significant for keypresses.
-
-
- SPACE drive kilobytes label
-
- Tests that drive has kilobytes free; if not, goes to label.
-
-
- TESTDIR path
-
- Tests to see if path contains any files (like those from a
- previous install). If so, confirms that user wants to continue
- installation.
-
-
- Labels
-
- The GODIR, GOTO, PICK, and SPACE commands can cause execution to
- branch to a label. As in DOS Batch, a label is a word on a line by
- itself with a colon in front of it.
-
-
- Running External Programs
-
- The installation script can run external programs by simply using its
- name, followed by any parameters (including %1, %2 or %3 that Install
- provides). The program name does not have to include an extension,
- and if no path is included in the name, the PATH environment variable
- will be used to find the program.
-
- If the program is a .COM or .EXE file, it is run directly by the
- Install program. This means that redirection is not possible. On the
- other hand, running an executable program sets ERRORLEVEL (see above
- under the IF command to see how ERRORLEVEL is used).
-
- If Install can't find the program to run, it calls the command
- processor (e.g. COMMAND.COM) to run it. This allows batch files and
- internal DOS commands to be run, and supports redirection, but always
- sets ERRORLEVEL to 0, regardless of the actual return value of the
- program.
-
-
-
-
-
-
-
-
- Page 12
-
- Install 3.37 September 6, 1991
-
-
- Default Configuration File
-
- A default configuration file can be included on the installation disk.
- This file can include default entries, no-default entries, a directory
- entry, a floppy entry and/or other game-specific constant information.
-
- There can be constant information in the default configuration file
- that the Install program doesn't change, use or even know about. One
- such entry is minHunk = 1000k (e.g.). Install will simply add any
- entries it doesn't understand to the installed configuration file.
- Install also adds any default, no-default and directory entries to the
- installed configuration file.
-
- Much of the following applies only to TSN.
-
- For most of the choices in the Install program, autodetection provides
- appropriate defaults. But for TSN, e.g., the choice of a default
- modem prefix string can be specified by a line in the default
- configuration file of the form default prefix = ATZ~!. ATZ~! will be
- the default prefix the user sees when he first installs TSN. He can
- also revert to that prefix by selecting "Return to Sierra defaults"
- from the Installation Choices screen. Default entries are not
- currently needed for other Sierra games.
-
- It can sometimes be necessary to require the user to make a decision,
- rather than simply giving him a default choice. This can be effected
- by including a line in the default configuration file of the form
- default touchtone = none (for the touchtone choice). This ensures
- that the touchtone choice menu will be displayed to the user when he
- runs the Install program. Anytime it is necessary to force the user
- to make an explicit choice a no-default entry should be included in
- the default configuration file.
-
- When updating a game from an update floppy (as is done for TSN) it is
- desirable to show the user his previous choices. To do this, a line
- of the form directory = \tsn should be included in the default
- configuration file. This would instruct the Install program to look
- in the \tsn directory for a previous configuration file.
-
- Normally, Sierra games can't be installed to a floppy drive, and the
- Install program won't allow drives A: or B: to be selected as the
- destination of the install. However, including the line floppy = yes
- in the default configuration file will allow installation to a floppy.
- If the destination floppy drive is the same as the installation drive,
- the installation script won't be executed; only the configuration file
- will be written.
-
-
-
-
-
-
-
-
- Page 13
-
- Install 3.37 September 6, 1991
-
-
- Changes History
-
- 3.37 9/6/91 Fixed YATB (Yet Another Tandy Bug) where the Tandy
- would hang while detecting extended memory if there is
- none.
-
- Made right window shadow narrower if in greater than
- 25-line mode to match size of bottom shadow.
-
- If an external command is redirected, don't clear
- screen.
-
- 3.36 9/4/91 Help for TSN phone number views a file containing phone
- numbers.
-
- 3.35 8/29/91 Wasn't getting text for joystick menu label from
- INSTALL.HLP.
-
- 3.34 8/28/91 Fixed video display routines to be compatible with
- UltraVision.
-
- 3.33 8/20/91 Clear screen on abort from critical error.
-
- 3.32 8/19/91 Added ability to execute external programs and test
- their return value with new IF ERRORLEVEL command.
-
- Fixed bug where port wasn't appended to sound and audio
- configuration lines.
-
- 3.31 8/2/91 Made command log window larger.
-
- 3.30 7/31/91 Major rewrite of display and window handling routines.
- The display speed is considerably faster. A few
- windows use different colors. Converted to large
- memory model, which has made the program bigger.
-
- 3.22 7/17/91 Improved error message when a text entry isn't found.
-
- 3.21a 7/17/91 (TSN only) New comm port detection.
-
- 3.21 7/16/91 Added option to view README file.
-
- When checking for extended memory capability and 0 is
- reported free, see if someone else might be using it;
- otherwise, say the user doesn't have extended memory
- capability. Takes care of cosmetic problem where a
- '286 with no extended memory allows user to "use extra
- memory" (even though the game would not actually try to
- use it).
-
-
-
-
-
- Page 14
-
- Install 3.37 September 6, 1991
-
-
- 3.20 7/15/91 Converted to compact model to make more memory
- available. This increased the size of the program by
- about 11,500 bytes.
-
- 3.15 Fixed bug where a Tandy with no extended memory could
- report a bogus amount.
-
- 3.14 Fixed bug where a file created by redirection could be
- read-only.
-
- 3.13 Fixed some bugs having to do with long text messages
- (observed when testing Spanish language version).
- Improved detection of full target disk.
-
- 3.12 Made the order of driver menu choices dependent on the
- order of the associated entries in INSTALL.HLP.
-
- Added autodetection for audio (Chris Smith).
-
- 3.11 Added floppy = yes entry to default config file.
-
- 3.10 Moved all text into text file(s).
-
- 3.00 Show menu of default choices. Read existing config
- file.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Page 15
-